/*=========================================================================

  Library:   CFS

  Copyright (c) Kitware Inc.

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0.txt

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

=========================================================================*/

#ifndef __CFSAbstractFileBasedFactory_tpp
#define __CFSAbstractFileBasedFactory_tpp

// Qt includes
#include <QDirIterator>

// CFS includes
#include "CFSAbstractFileBasedFactory.h"

//----------------------------------------------------------------------------
// CFSFactoryFileBasedItem methods

//----------------------------------------------------------------------------
template<typename BaseClassType>
void CFSAbstractFactoryFileBasedItem<BaseClassType>::setPath(const QString& path)
{
  this->Path = path;
}

//----------------------------------------------------------------------------
template<typename BaseClassType>
QString CFSAbstractFactoryFileBasedItem<BaseClassType>::path()const
{
  return this->Path;
}

//----------------------------------------------------------------------------
// CFSAbstractFileBasedFactory methods

//----------------------------------------------------------------------------
template<typename BaseClassType>
QString CFSAbstractFileBasedFactory<BaseClassType>::path(const QString& key)
{
  CFSAbstractFactoryFileBasedItem<BaseClassType>* _item =
      dynamic_cast<CFSAbstractFactoryFileBasedItem<BaseClassType>*>(this->item(key));
  Q_ASSERT(_item);
  return _item->path();
}

//-----------------------------------------------------------------------------
template<typename BaseClassType>
void CFSAbstractFileBasedFactory<BaseClassType>::registerAllFileItems(const QStringList& directories)
{
  // Process one path at a time
  foreach (QString path, directories)
    {
    QDirIterator it(path);
    while (it.hasNext())
      {
      it.next();
      QFileInfo fileInfo = it.fileInfo();
      if (fileInfo.isSymLink())
        {
        // symLinkTarget() handles links pointing to symlinks.
        // How about a symlink pointing to a symlink ?
        fileInfo = QFileInfo(fileInfo.symLinkTarget());
        }
      // Skip if item isn't a file
      if (!this->isValidFile(fileInfo))
        {
        continue;
        }
      this->registerFileItem(fileInfo);
      }
    }
}

//-----------------------------------------------------------------------------
template<typename BaseClassType>
QString CFSAbstractFileBasedFactory<BaseClassType>
::itemKey(const QFileInfo& fileInfo)const
{
  return this->fileNameToKey(fileInfo.filePath());
}

//-----------------------------------------------------------------------------
template<typename BaseClassType>
QString CFSAbstractFileBasedFactory<BaseClassType>
::registerFileItem(const QFileInfo& fileInfo)
{
  QString key = this->itemKey(fileInfo);
  bool registered = this->registerFileItem(key, fileInfo);
  return registered ? key : QString();
}

//-----------------------------------------------------------------------------
template<typename BaseClassType>
bool CFSAbstractFileBasedFactory<BaseClassType>
::registerFileItem(const QString& key, const QFileInfo& fileInfo)
{
  QString description = QString("Attempt to register \"%1\"").arg(key);
  if (this->item(key))
    {
    this->displayStatusMessage(QtWarningMsg, description, "Already registered", this->verbose());
    return true;
    }
  if (this->sharedItem(key))
    {
    this->displayStatusMessage(QtDebugMsg, description,
                               "Already registered in other factory", this->verbose());
    return false;
    }
  QSharedPointer<CFSAbstractFactoryItem<BaseClassType> >
    itemToRegister(this->createFactoryFileBasedItem());
  if (itemToRegister.isNull())
    {
    this->displayStatusMessage(QtWarningMsg, description,
                               "Failed to create FileBasedItem", this->verbose());
    return false;
    }
  dynamic_cast<CFSAbstractFactoryFileBasedItem<BaseClassType>*>(itemToRegister.data())
    ->setPath(fileInfo.filePath());
  this->initItem(itemToRegister.data());
  return this->registerItem(key, itemToRegister);
}

//-----------------------------------------------------------------------------
template<typename BaseClassType>
bool CFSAbstractFileBasedFactory<BaseClassType>
::isValidFile(const QFileInfo& file)const
{
  return file.isFile();
}

//-----------------------------------------------------------------------------
template<typename BaseClassType>
CFSAbstractFactoryItem<BaseClassType>* CFSAbstractFileBasedFactory<BaseClassType>
::createFactoryFileBasedItem()
{
  return 0;
}

//-----------------------------------------------------------------------------
template<typename BaseClassType>
void CFSAbstractFileBasedFactory<BaseClassType>::
initItem(CFSAbstractFactoryItem<BaseClassType>* item)
{
  item->setVerbose(this->verbose());
}

//-----------------------------------------------------------------------------
template<typename BaseClassType>
QString CFSAbstractFileBasedFactory<BaseClassType>
::fileNameToKey(const QString& fileName)const
{
  return QFileInfo(fileName).baseName();
}

#endif
